com.highdeal.hci
Class UserOperationModel

java.lang.Object
  com.highdeal.hci.UserOperationModel

All Implemented Interfaces:

XMLMarshallable

public class UserOperationModel
extends java.lang.Object
implements XMLMarshallable

This Java class represents a user operation that has been processed and recorded by the SAP CC system; Your client application can consult the operation results by implepement the handling of audits or by using the existing user interfaces to audit operations.

A user operation contains:

• The reference of the user operation (its unique identifier in the system)
• The name of the operation executed
• The name of the operator (user login) which executed the operation
• The code or the reference (if no code exists) of the operand
• A message if an error occurred when executing the operation
• The date when it was recorded by the system

Notes

• Charging operations are not recorded by the system.
• Search operations are only recorded if an error occurs.

See Also:

AuditModel

XML API for HCI

The XML APIs specify the following XSD fragment:

XSD Fragment

<xs:element name="userOperation">
   <xs:complexType>
     <xs:attribute name="reference" type="xs:long"/>
     <xs:attribute name="operationName" type="xs:string"/>
     <xs:attribute name="operatorName" type="xs:string" />
     <xs:attribute name="operandReference" type="xs:string" />
     <xs:attribute name="message" type="xs:string" default=""/>
     <xs:attribute name="recordingDate" type="xs:dateTime"/>
   </xs:complexType>
 </xs:element>

Field Summary

static java.lang.String

RESULT_MESSAGE The result message for a successful operation: "__RESULT__MESSAGE__"

Constructor Summary

UserOperationModel()
Creates an uninitialized user operation.

UserOperationModel(java.lang.String operationName, java.lang.String operatorName, java.lang.String operandReference, java.util.Date recordingDate)
Creates a user operation for a successful execution (no error message is specified).

UserOperationModel(java.lang.String operationName, java.lang.String operatorName, java.lang.String operandReference, java.lang.String message, java.util.Date recordingDate)
Creates a user operation for a failed execution (an error message is specified).

Method Summary

void	addCharacterData(java.lang.String cData) Adds character data to the content element.
void	addChild(java.lang.String tagname, XMLMarshallable child) Adds a child to the object, the child representing the marshallable object which must be added to the element.
java.lang.String	getMessage() Returns the message of the error.
java.lang.String	getOperandReference() Returns the code or the reference (if no code exists) of the operand.
java.lang.String	getOperationName() Returns the name of the operation executed.
java.lang.String	getOperatorName() Returns the name of the operator (user login) which executed the operation.
java.util.Date	getRecordingDate() Returns the date when the operation was recorded by the system.
long	getReference() Returns the reference of the user operation (its unique identifier in the system).
void	marshal(XMLOutputter output) Gives an XML representation of this object, including its children.
void	setAttributes(XMLAttributes atts) Sets the attributes of the XML representation of the element being processed.
void	setMessage(java.lang.String message) Sets the message of the error.
void	setOperandReference(java.lang.String operandReference) Sets the code or the reference (if no code exists) of the operand.
void	setOperationName(java.lang.String operationName) Sets the name of the operation executed.
void	setOperatorName(java.lang.String operatorName) Sets the name of the operator (user login) which executed the operation.
void	setRecordingDate(java.util.Date recordingDate) Sets the date when the operation was recorded by the system.
void	setReference(long reference) Sets the reference of the user operation (its unique identifier in the system).

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

RESULT_MESSAGE

public static final java.lang.String RESULT_MESSAGE

The result message for a successful operation: "__RESULT__MESSAGE__"

See Also:

Constant Field Values

Constructor Detail

UserOperationModel

public UserOperationModel()

Creates an uninitialized user operation.

UserOperationModel

public UserOperationModel(java.lang.String operationName,
                          java.lang.String operatorName,
                          java.lang.String operandReference,
                          java.util.Date recordingDate)

Creates a user operation for a successful execution (no error message is specified).

Parameters:

operationName - The name of the operation executed

operatorName - The name of the operator (user login) which executed the operation

operandReference - The code or the reference (if no code exists) of the operand

recordingDate - The date when the operation was recorded by the system

UserOperationModel

public UserOperationModel(java.lang.String operationName,
                          java.lang.String operatorName,
                          java.lang.String operandReference,
                          java.lang.String message,
                          java.util.Date recordingDate)

Creates a user operation for a failed execution (an error message is specified).

Parameters:

operationName - The name of the operation executed

operatorName - The name of the operator (user login) which executed the operation

operandReference - The code or the reference (if no code exists) of the operand

message - The code or the reference (if no code exists) of the operand

recordingDate - The date when the operation was recorded by the system

Method Detail

getOperationName

public java.lang.String getOperationName()

Returns the name of the operation executed.

Returns:

The name of the operation executed

setOperationName

public void setOperationName(java.lang.String operationName)

Sets the name of the operation executed.

Parameters:

operationName - The name of the operation executed

getOperatorName

public java.lang.String getOperatorName()

Returns the name of the operator (user login) which executed the operation.

Returns:

The name of the operator (user login) which executed the operation

setOperatorName

public void setOperatorName(java.lang.String operatorName)

Sets the name of the operator (user login) which executed the operation.

Parameters:

operatorName - The name of the operator (user login) which executed the operation

getOperandReference

public java.lang.String getOperandReference()

Returns the code or the reference (if no code exists) of the operand.

Returns:

The code or the reference (if no code exists) of the operand

setOperandReference

public void setOperandReference(java.lang.String operandReference)

Sets the code or the reference (if no code exists) of the operand.

Parameters:

operandReference - The code or the reference (if no code exists) of the operand

getMessage

public java.lang.String getMessage()

Returns the message of the error.

Returns:

The message of the error

setMessage

public void setMessage(java.lang.String message)

Sets the message of the error.

Parameters:

message - The message of the error

getRecordingDate

public java.util.Date getRecordingDate()

Returns the date when the operation was recorded by the system.

Returns:

The date when the operation was recorded by the system

setRecordingDate

public void setRecordingDate(java.util.Date recordingDate)

Sets the date when the operation was recorded by the system.

Parameters:

recordingDate - The date when the operation was recorded by the system

getReference

public long getReference()

Returns the reference of the user operation (its unique identifier in the system).

Returns:

The reference of the user operation (its unique identifier in the system)

setReference

public void setReference(long reference)

Sets the reference of the user operation (its unique identifier in the system).

Parameters:

reference - The reference of the user operation (its unique identifier in the system)

addChild

public void addChild(java.lang.String tagname,
                     XMLMarshallable child)

Description copied from interface: XMLMarshallable

Adds a child to the object, the child representing the marshallable object which must be added to the element.

Specified by:

addChild in interface XMLMarshallable

Parameters:

tagname - The name of tag for the child

child - The child to be added

addCharacterData

public void addCharacterData(java.lang.String cData)

Description copied from interface: XMLMarshallable

Adds character data to the content element.

Specified by:

addCharacterData in interface XMLMarshallable

Parameters:

cData - The character data to be added

setAttributes

public void setAttributes(XMLAttributes atts)

Description copied from interface: XMLMarshallable

Sets the attributes of the XML representation of the element being processed.

Specified by:

setAttributes in interface XMLMarshallable

Parameters:

atts - The XML attributes of the current element

marshal

public void marshal(XMLOutputter output)

Description copied from interface: XMLMarshallable

Gives an XML representation of this object, including its children.

Specified by:

marshal in interface XMLMarshallable

Parameters:

output - The XML output to marshal the object into